Feature/action docs sections #6060
Conversation
|
This would be a good complement to the work done in #5605. I'm curious if this would work as expected with the method mapping introduced in the PR. e.g., something like: class SomeViewSet(viewsets.ModelViewSet):
@action(detail=False, methods=['get', 'post'])
def some_action(self, request, *args, **kwargs):
"""
get:
A description of the get method on the custom action.
post:
A description of the post method on the custom action.
"""
@some_action.mapping.put
def put_some_action():
"""
A description of the put method on the custom action.
""" |
|
I'm adding this to the 3.9 milestone to ensure it's considered. |
There was a problem hiding this comment.
#5605 is in, so we should consider that.
In general I want to avoid adding complexity to the docstring parsing, since that way lies insanity. But this particular change is small, so it may be worth it.
|
Hi @OmegaDroid. Would you be willing to write a test for extra actions, as laid out above? |
|
@rpkilby yeah i'll take a look, do you mean writing tests for adding docs from |
|
Yes - that would be great if you have the time. Ideally, the docs would include sections for all three HTTP methods. |
|
This is OK I think, except totally undocumented. It needs an addition to the Documenting your views section of the docs there. Inclined to hold-off until we see how #6119 comes out. I'm going to de-milestone. @OmegaDroid If you add the docs I'm happy to merge it. |
Codecov Report
@@ Coverage Diff @@
## master #6060 +/- ##
==========================================
- Coverage 96.18% 95.82% -0.36%
==========================================
Files 128 129 +1
Lines 17630 17877 +247
Branches 1458 1479 +21
==========================================
+ Hits 16957 17131 +174
- Misses 465 540 +75
+ Partials 208 206 -2 |
|
Hi @carltongibson, I've added some docs for the custom action documentation. Let me know if there's anything else. |
|
Thanks @OmegaDroid for putting the work in on this. |
* added ability to add sections to custom action documentation * added tests to cover docs sections in custom actions * added method specific docs test for action mapping * added docs for custom action documentation
Description
I require the ability to split action data documentation into sections (similar to
list: .. create: ...from the viewsets docstring).I've altered the code so that the method docstring is handled in a similar way to the viewsets description which allows for the documentation sections on actions using
get:,post:etc.Cheers